home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUISpinnerProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-02-07  |  4.9 KB  |  166 lines
  1. /************************************************************************
  2.     filename:     CEGUISpinnerProperties.h
  3.     created:    7/2/2005
  4.     author:        Paul D Turner
  5. *************************************************************************/
  6. /*************************************************************************
  7.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  8.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  9.  
  10.     This library is free software; you can redistribute it and/or
  11.     modify it under the terms of the GNU Lesser General Public
  12.     License as published by the Free Software Foundation; either
  13.     version 2.1 of the License, or (at your option) any later version.
  14.  
  15.     This library is distributed in the hope that it will be useful,
  16.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18.     Lesser General Public License for more details.
  19.  
  20.     You should have received a copy of the GNU Lesser General Public
  21.     License along with this library; if not, write to the Free Software
  22.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23. *************************************************************************/
  24. #ifndef _CEGUISpinnerProperties_h_
  25. #define _CEGUISpinnerProperties_h_
  26.  
  27. #include "CEGUIProperty.h"
  28.  
  29.  
  30. // Start of CEGUI namespace section
  31. namespace CEGUI
  32. {
  33. // Start of SpinnerProperties namespace section
  34. namespace SpinnerProperties
  35. {
  36.     /*!
  37.     \brief
  38.         Property to access the current value of the spinner.
  39.  
  40.         \par Usage:
  41.             - Name: CurrentValue
  42.             - Format: "[float]".
  43.  
  44.         \par Where:
  45.             - [float] represents the current value of the Spinner widget.
  46.     */
  47.     class CurrentValue : public Property
  48.     {
  49.     public:
  50.         CurrentValue() : Property(
  51.             "CurrentValue",
  52.             "Property to get/set the current value of the spinner.  Value is a float.",
  53.             "0.000000")
  54.         {}
  55.  
  56.         String get(const PropertyReceiver* receiver) const;
  57.         void set(PropertyReceiver* receiver, const String& value);
  58.     };
  59.  
  60.     /*!
  61.     \brief
  62.         Property to access the step size of the spinner.
  63.  
  64.         \par Usage:
  65.             - Name: StepSize
  66.             - Format: "[float]".
  67.  
  68.         \par Where:
  69.             - [float] represents the current value of the Spinner widget.
  70.     */
  71.     class StepSize : public Property
  72.     {
  73.     public:
  74.         StepSize() : Property(
  75.             "StepSize",
  76.             "Property to get/set the step size of the spinner.  Value is a float.",
  77.             "1.000000")
  78.         {}
  79.  
  80.         String get(const PropertyReceiver* receiver) const;
  81.         void set(PropertyReceiver* receiver, const String& value);
  82.     };
  83.  
  84.     /*!
  85.     \brief
  86.         Property to access the minimum value setting of the spinner.
  87.  
  88.         \par Usage:
  89.             - Name: MinimumValue
  90.             - Format: "[float]".
  91.  
  92.         \par Where:
  93.             - [float] represents the current minimum value of the Spinner widget.
  94.     */
  95.     class MinimumValue : public Property
  96.     {
  97.     public:
  98.         MinimumValue() : Property(
  99.             "MinimumValue",
  100.             "Property to get/set the minimum value setting of the spinner.  Value is a float.",
  101.             "-32768.000000")
  102.         {}
  103.  
  104.         String get(const PropertyReceiver* receiver) const;
  105.         void set(PropertyReceiver* receiver, const String& value);
  106.     };
  107.  
  108.     /*!
  109.     \brief
  110.         Property to access the maximum value setting of the spinner.
  111.  
  112.         \par Usage:
  113.             - Name: MaximumValue
  114.             - Format: "[float]".
  115.  
  116.         \par Where:
  117.             - [float] represents the current maximum value of the Spinner widget.
  118.     */
  119.     class MaximumValue : public Property
  120.     {
  121.     public:
  122.         MaximumValue() : Property(
  123.             "MaximumValue",
  124.             "Property to get/set the maximum value setting of the spinner.  Value is a float.",
  125.             "32767.000000")
  126.         {}
  127.  
  128.         String get(const PropertyReceiver* receiver) const;
  129.         void set(PropertyReceiver* receiver, const String& value);
  130.     };
  131.  
  132.     /*!
  133.     \brief
  134.         Property to access the TextInputMode setting.
  135.  
  136.         This property offers access the text display and input mode for the spinner.
  137.  
  138.         \par Usage:
  139.             - Name: TextInputMode
  140.             - Format: "[text]".
  141.  
  142.         \par Where [text] is:
  143.             - "FloatingPoint" for floating point decimal numbers.
  144.             - "Integer" for integer decimal numbers.
  145.             - "Hexadecimal" for hexadecimal numbers.
  146.             - "Octal" for octal numbers.
  147.     */
  148.     class TextInputMode : public Property
  149.     {
  150.     public:
  151.         TextInputMode() : Property(
  152.             "TextInputMode",
  153.             "Property to get/set the TextInputMode setting for the spinner.  Value is \"FloatingPoint\", \"Integer\", \"Hexadecimal\", or \"Octal\".",
  154.             "Integer")
  155.         {}
  156.  
  157.         String    get(const PropertyReceiver* receiver) const;
  158.         void    set(PropertyReceiver* receiver, const String& value);
  159.     };
  160.  
  161. } // End of  SpinnerProperties namespace section
  162. } // End of  CEGUI namespace section
  163.  
  164.  
  165. #endif    // end of guard _CEGUISpinnerProperties_h_
  166.